﻿//	Copyright (c) 2012 Jonathan Loe
//
//	MIT license (http://en.wikipedia.org/wiki/MIT_License)
//
//	Permission is hereby granted, free of charge, to any person obtaining a copy
//	of this software and associated documentation files (the "Software"), to deal
//	in the Software without restriction, including without limitation the rights 
//	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
//	of the Software, and to permit persons to whom the Software is furnished to do so, 
//	subject to the following conditions:
//
//	The above copyright notice and this permission notice shall be included in all 
//	copies or substantial portions of the Software.
//
//	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
//	INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
//	PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE 
//	FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
//	ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using Ordinaire.Security.Data;

namespace Ordinaire.Security
{
    /// <summary>
    /// Used for other authentication mechanism.
    /// </summary>
    public interface IAuthentication
    {
        /// <summary>
        /// Verifies the specified username and password exist and match.
        /// </summary>
        /// <param name="username">the username to verified</param>
        /// <param name="password">the password of the specified username</param>
        /// <returns>data if both username and password are correct, else null</returns>
        UserData Authenticate(string username, string password);

        /// <summary>
        /// Updates current password of specified username with a desired one.
        /// </summary>
        /// <param name="username">the username who wish to change the password</param>
        /// <param name="current">current password of the specified username</param>
        /// <param name="desired">the new password</param>
        /// <param name="who">user who initiates the change</param>
        /// <returns>true if password has been changed successfully</returns>
        bool ChangePassword(string username, string current, string desired, User who);

        /// <summary>
        /// Creates new user with the specified username and password.
        /// </summary>
        /// <param name="username">new user's id</param>
        /// <param name="password">new user's password</param>
        /// <param name="who">user who creates</param>
        /// <returns>user details that have been created</returns>
        UserData NewUser(string username, string password, User who);

        /// <summary>
        /// Clears and creates fresh list of users.
        /// </summary>
        /// <param name="userPasswords">pairs of user and password</param>
        /// <param name="creatorId">userid who initiates</param>
        /// <returns>list of created users</returns>
        List<User> Setup(List<KeyValuePair<string, string>> userPasswords, string creatorId);
    }
}
